| Package | hl7.org.nz.fhir.ig.hpi |
| Type | CapabilityStatement |
| Id | Id |
| FHIR Version | R4 |
| Source | http://hl7.org.nz/fhir/ig/hpi/https://build.fhir.org/ig/HL7NZ/hpi/CapabilityStatement-HpiCapabilityStatement.html |
| Url | http://hl7.org.nz/fhir/ig/hpi/CapabilityStatement/HpiCapabilityStatement |
| Version | 0.9.0 |
| Status | draft |
| Date | 2020-04-01 |
| Name | HPI_CapabilityStatement |
| Title | Capability Statement describing HPI FHIR APIs |
| Experimental | False |
| Realm | nz |
| Authority | hl7 |
| Description | This is the computable resource that describes the RESTful endpoint |
| Kind | instance |
No resources found
No resources found
Note: links and images are rebased to the (stated) source
FHIR{
"resourceType" : "CapabilityStatement",
"id" : "HpiCapabilityStatement",
"text" : {
"status" : "additional",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\">HPI capabilities</div>"
},
"url" : "http://hl7.org.nz/fhir/ig/hpi/CapabilityStatement/HpiCapabilityStatement",
"version" : "0.9.0",
"name" : "HPI_CapabilityStatement",
"title" : "Capability Statement describing HPI FHIR APIs",
"status" : "draft",
"date" : "2020-04-01",
"publisher" : "Ministry of Health",
"contact" : [
{
"name" : "Ministry of Health",
"telecom" : [
{
"system" : "email",
"value" : "mailto:integration@health.govt.nz"
}
]
}
],
"description" : "This is the computable resource that describes the RESTful endpoint",
"jurisdiction" : [
{
"coding" : [
{
"system" : "urn:iso:std:iso:3166",
"code" : "NZ"
}
]
}
],
"kind" : "instance",
"implementation" : {
"description" : "The HPI endpoint",
"url" : "https://api.hip.digital.health.nz/fhir/hpi/v1/"
},
"fhirVersion" : "4.0.1",
"format" : [
"json"
],
"rest" : [
{
"mode" : "server",
"resource" : [
{
"type" : "Practitioner",
"supportedProfile" : [
"http://hl7.org.nz/fhir/StructureDefinition/hpi-practitioner"
],
"documentation" : "Practitioner query\n",
"interaction" : [
{
"code" : "read",
"documentation" : "Used to retrieve a Practitioner resource by Id."
},
{
"code" : "search-type"
}
],
"searchParam" : [
{
"name" : "identifier",
"type" : "token"
},
{
"name" : "name",
"type" : "string",
"documentation" : "Not case sensitive"
},
{
"name" : "family",
"type" : "string"
},
{
"name" : "given",
"type" : "string"
},
{
"name" : "gender",
"type" : "token"
},
{
"name" : "birthdate",
"type" : "date",
"documentation" : "Supports a search on practitioner birthdate"
}
]
},
{
"type" : "PractitionerRole",
"supportedProfile" : [
"http://hl7.org.nz/fhir/StructureDefinition/hpi-practitioner-role"
],
"documentation" : "PractitionerRole query\n",
"interaction" : [
{
"code" : "read",
"documentation" : "Used to retrieve a PractitionerRole resource by Id."
},
{
"code" : "search-type"
},
{
"code" : "create",
"documentation" : "Create a new PractitionerRole"
},
{
"code" : "update",
"documentation" : "Update an existing PractitionerRole"
}
],
"searchInclude" : [
"practitioner",
"organization",
"location"
],
"searchParam" : [
{
"name" : "practitioner",
"type" : "reference",
"documentation" : "Given a Practitioner id, returns the PractitionerRoles associated with that id"
},
{
"name" : "organization",
"type" : "reference",
"documentation" : "Given a Organization id, returns the PractitionerRoles associated with that id"
},
{
"name" : "location",
"type" : "token",
"documentation" : "Given a Location id, returns the PractitionerRoles associated with that id"
},
{
"name" : "identifier",
"type" : "token",
"documentation" : "Returns PractitionerRoles based on identifier"
},
{
"name" : "role",
"type" : "token",
"documentation" : "Returns PractitionerRoles based on role"
},
{
"name" : "active",
"type" : "token",
"documentation" : "To enable exclusion of inactive PractitionerRoles"
}
]
},
{
"type" : "Organization",
"supportedProfile" : [
"http://hl7.org.nz/fhir/StructureDefinition/hpi-organization"
],
"documentation" : "Organization query\n",
"interaction" : [
{
"code" : "read",
"documentation" : "Used to retrieve an Organization resource by Id."
},
{
"code" : "search-type"
}
],
"searchParam" : [
{
"name" : "active",
"type" : "token",
"documentation" : "To enable exclusion of inactive organizations"
},
{
"name" : "name",
"type" : "string",
"documentation" : "Will only return active organizations"
},
{
"name" : "identifier",
"type" : "token",
"documentation" : "The HPI Organization id or the New Zealand Business Number (NZBN)."
},
{
"name" : "partOf",
"type" : "reference",
"documentation" : "Locates Organizations that are 'part of' another. "
}
]
},
{
"type" : "Location",
"supportedProfile" : [
"http://hl7.org.nz/fhir/StructureDefinition/hpi-location"
],
"documentation" : "Location query\n",
"interaction" : [
{
"code" : "search-type"
}
],
"searchParam" : [
{
"name" : "identifier",
"type" : "token",
"documentation" : "Retrieve the Location with the identifier"
},
{
"name" : "name",
"type" : "string",
"documentation" : "Retrieve the Locations with the matching name or alias"
},
{
"name" : "type",
"type" : "token",
"documentation" : "Retrieve Locations of the given type"
},
{
"name" : "address",
"type" : "string",
"documentation" : "Retrieve the Locations by address"
},
{
"name" : "organization",
"type" : "reference",
"documentation" : "Locations with the given ManagingOrganization"
},
{
"name" : "dhb",
"type" : "token",
"documentation" : "Locations that are in a DHBs catchment area. This is a custom search"
},
{
"name" : "status",
"type" : "token",
"documentation" : "The current status of the Location"
}
]
}
]
}
]
}
XIG built as of ??metadata-date??. Found ??metadata-resources?? resources in ??metadata-packages?? packages.